hast-util-select
Advanced tools
hast utility with equivalents querySelector, querySelectorAll,
and matches.
One notable difference between DOM and hast is that DOM nodes have references
to their parents, meaning that document.body.matches(':last-child') can
be evaluated.
This information is not stored in hast, so selectors like that don’t work.
View the list of supported selectors »
npm:
npm install hast-util-select
select.matches(selector, node[, space])Check that the given node matches selector.
Returns boolean, whether the node matches or not.
This only checks the element itself, not the surrounding tree.
Thus, nesting in selectors is not supported (p b, p > b), neither are
selectors like :first-child, etc.
This only checks that the given element matches the selector.
var h = require('hastscript')
var matches = require('hast-util-select').matches
matches('b, i', h('b')) // => true
matches(':any-link', h('a')) // => false
matches(':any-link', h('a', {href: '#'})) // => true
matches('.classy', h('a', {className: ['classy']})) // => true
matches('#id', h('a', {id: 'id'})) // => true
matches('[lang|=en]', h('a', {lang: 'en'})) // => true
matches('[lang|=en]', h('a', {lang: 'en-GB'})) // => true
// ...
selector (string)
— CSS selectors (, is also supported)node (Node)
— Thing to check, could be anything, but should be an elementspace (enum, 'svg' or 'html', default: 'html')
— Which space the node exists inboolean — Whether the node matches the selector.
select.select(selector, tree[, space])Select the first node matching selector in the given tree (could be the
tree itself).
Searches the tree in preorder.
var h = require('hastscript')
var select = require('hast-util-select').select
console.log(
select(
'h1 ~ :nth-child(even)',
h('section', [
h('p', 'Alpha'),
h('p', 'Bravo'),
h('h1', 'Charlie'),
h('p', 'Delta'),
h('p', 'Echo')
])
)
)
Yields:
{ type: 'element',
tagName: 'p',
properties: {},
children: [ { type: 'text', value: 'Delta' } ] }
selector (string) — CSS selectors (, is also supported)tree (Node) — Tree to searchspace (enum, 'svg' or 'html', default: 'html')
— Which space the tree exists inElement? — The found element, if any.
select.selectAll(selector, tree[, space])Select all nodes matching selector in the given tree (could include the tree
itself).
Searches the tree in preorder.
var h = require('hastscript')
var selectAll = require('hast-util-select').selectAll
console.log(
selectAll(
'h1 ~ :nth-child(even)',
h('section', [
h('p', 'Alpha'),
h('p', 'Bravo'),
h('h1', 'Charlie'),
h('p', 'Delta'),
h('p', 'Echo'),
h('p', 'Foxtrot'),
h('p', 'Golf')
])
)
)
Yields:
[ { type: 'element',
tagName: 'p',
properties: {},
children: [ { type: 'text', value: 'Delta' } ] },
{ type: 'element',
tagName: 'p',
properties: {},
children: [ { type: 'text', value: 'Foxtrot' } ] } ]
selector (string) — CSS selectors (, is also supported)tree (Node) — Tree to searchspace (enum, 'svg' or 'html', default: 'html')
— Which space the tree exists inArray.<Element> — All found elements, if any.
* (universal selector), (multiple selector)p (type selector).class (class selector)#id (id selector)article p (combinator: descendant selector)article > p (combinator: child selector)h1 + p (combinator: next-sibling selector)h1 ~ p (combinator: subsequent sibling selector)[attr] (attribute existence)[attr=value] (attribute equality)[attr~=value] (attribute contains in space-separated list)[attr|=value] (attribute equality or prefix)[attr^=value] (attribute begins with)[attr$=value] (attribute ends with)[attr*=value] (attribute contains):any() (functional pseudo-class, use :matches instead):dir() (functional pseudo-class):has() (functional pseudo-class):lang() (functional pseudo-class):matches() (functional pseudo-class):not() (functional pseudo-class):any-link (pseudo-class):blank (pseudo-class):checked (pseudo-class):disabled (pseudo-class):empty (pseudo-class):enabled (pseudo-class):optional (pseudo-class):read-only (pseudo-class):read-write (pseudo-class):required (pseudo-class):root (pseudo-class):scope (pseudo-class)::first-child (pseudo-class):first-of-type (pseudo-class):last-child (pseudo-class):last-of-type (pseudo-class):only-child (pseudo-class):only-of-type (pseudo-class):nth-child() (functional pseudo-class):nth-last-child() (functional pseudo-class):nth-last-of-type() (functional pseudo-class):nth-of-type() (functional pseudo-class)|| (column combinator)ns|E (namespace type selector)*|E (any namespace type selector)|E (no namespace type selector)[ns|attr] (namespace attribute)[*|attr] (any namespace attribute)[|attr] (no namespace attribute)[attr=value i] (attribute case-insensitive):has() (functional pseudo-class).
Relative selectors (:has(> img)) are not supported, but scope is
(:has(:scope > img)) :nth-child(n of S) (functional pseudo-class).
Scoping to parents is not supported:nth-last-child(n of S) (scoped to parent S).
Scoping to parents is not supported:active (pseudo-class):current (pseudo-class):current() (functional pseudo-class):default (pseudo-class):defined (pseudo-class):drop (pseudo-class):drop() (functional pseudo-class):focus (pseudo-class):focus-visible (pseudo-class):focus-within (pseudo-class):fullscreen (pseudo-class):future (pseudo-class):host() (functional pseudo-class):host-context() (functional pseudo-class):hover (pseudo-class):in-range (pseudo-class):indeterminate (pseudo-class):invalid (pseudo-class):link (pseudo-class):local-link (pseudo-class):nth-column() (functional pseudo-class):nth-last-column() (functional pseudo-class):out-of-range (pseudo-class):past (pseudo-class):paused (pseudo-class):placeholder-shown (pseudo-class):playing (pseudo-class):something() (functional pseudo-class):target (pseudo-class):target-within (pseudo-class):user-error (pseudo-class):user-invalid (pseudo-class):valid (pseudo-class):visited (pseudo-class)::before (pseudo-elements: none are supported)matcheshast-util-select does not change the syntax tree so there are no openings for
cross-site scripting (XSS) attacks.
unist-util-select
— select unist nodes with CSS-like selectorshast-util-find-and-replace
— find and replace text in a hast treehast-util-parse-selector
— create an element from a simple CSS selectorhast-util-from-selector
— create an element from a complex CSS selectorSee contributing.md in syntax-tree/.github for ways to get
started.
See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
hast utility for `querySelector`, `querySelectorAll`, and `matches`
The npm package hast-util-select receives a total of 207,467 weekly downloads. As such, hast-util-select popularity was classified as popular.
We found that hast-util-select demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.
Security News
PyPI now allows maintainers to archive projects, improving security and helping users make informed decisions about their dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.